Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
AddPolygonToRegion(RasterRegionXForm,Generic RasterCollection,FillMode,RasterRegionCombineMode) Method
See Also  Example
Leadtools Namespace > RasterImage Class > AddPolygonToRegion Method : AddPolygonToRegion(RasterRegionXForm,Generic RasterCollection,FillMode,RasterRegionCombineMode) Method



xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null (Nothing in Visual Basic) in this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to the image view perspective.
points
A collection of Point objects. The points in the collection must be in the order in which the vertices of the polygon are connected. To create the line that closes the polygon, the last point in the collection is connected to the first point of the collection.
fillMode

Indicates how to handle complex crossing lines.

Value Meaning
Winding All pixels that are inside the resulting exterior lines are in the region.
Alternate The region includes the area between odd-numbered and even-numbered polygon sides on each scan line.

combineMode
The action to take regarding the existing image region, if one is defined.
Creates or updates the image region by adding a polygonal region.

Syntax

Visual Basic (Declaration) 
Public Overloads Sub AddPolygonToRegion( _
   ByVal xform As RasterRegionXForm, _
   ByVal points As RasterCollection(Of Point), _
   ByVal fillMode As FillMode, _
   ByVal combineMode As RasterRegionCombineMode _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim xform As RasterRegionXForm
Dim points As RasterCollection(Of Point)
Dim fillMode As FillMode
Dim combineMode As RasterRegionCombineMode
 
instance.AddPolygonToRegion(xform, points, fillMode, combineMode)
C# 
public void AddPolygonToRegion( 
   RasterRegionXForm xform,
   RasterCollection<Point> points,
   FillMode fillMode,
   RasterRegionCombineMode combineMode
)
C++/CLI 
public:
void AddPolygonToRegion( 
   RasterRegionXForm^ xform,
   RasterCollection<Point>^ points,
   FillMode fillMode,
   RasterRegionCombineMode combineMode
) 

Parameters

xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null (Nothing in Visual Basic) in this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to the image view perspective.
points
A collection of Point objects. The points in the collection must be in the order in which the vertices of the polygon are connected. To create the line that closes the polygon, the last point in the collection is connected to the first point of the collection.
fillMode

Indicates how to handle complex crossing lines.

Value Meaning
Winding All pixels that are inside the resulting exterior lines are in the region.
Alternate The region includes the area between odd-numbered and even-numbered polygon sides on each scan line.

combineMode
The action to take regarding the existing image region, if one is defined.

Example

This example will load an image, adds a polygon region to it, run the InvertCommand to show the affected area before saving the image back to disk.

Visual BasicCopy Code
Public Sub AddPolygonToRegionExample()
   RasterCodecs.Startup()
   Dim codecs As RasterCodecs = New RasterCodecs()

   Dim srcFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"
   Dim destFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1_AddPolygonToRegion.bmp"

   ' Load the image
   Dim image As RasterImage = codecs.Load(srcFileName)

   ' Add a polygon region

   Dim xform As RasterRegionXForm = New RasterRegionXForm()
   xform.ViewPerspective = RasterViewPerspective.TopLeft
   xform.XOffset = 0
   xform.YOffset = 0
   xform.XScalarDenominator = 1
   xform.XScalarNumerator = 1
   xform.YScalarDenominator = 1
   xform.YScalarNumerator = 1

   Dim x1 As Integer = image.ImageWidth \ 4
   Dim y1 As Integer = image.ImageHeight \ 4
   Dim x2 As Integer = image.ImageWidth \ 3
   Dim y2 As Integer = image.ImageHeight \ 3

   Dim pts As Point() = {New Point(x1, y1), New Point(x2, y1), New Point(x1, y2), New Point(x2, y2)}

   image.AddPolygonToRegion(xform, pts, FillMode.Winding, RasterRegionCombineMode.Set)

   ' Draw something on the image
   Dim command As InvertCommand = New InvertCommand()
   command.Run(image)

   ' Save the image
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24)

   image.Dispose()
   codecs.Dispose()
   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void AddPolygonToRegionExample() 

   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"; 
   string destFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1_AddPolygonToRegion.bmp"; 
 
   // Load the image 
   RasterImage image = codecs.Load(srcFileName); 
 
   // Add a polygon region 
 
   RasterRegionXForm xform = new RasterRegionXForm(); 
   xform.ViewPerspective = RasterViewPerspective.TopLeft; 
   xform.XOffset = 0; 
   xform.YOffset = 0; 
   xform.XScalarDenominator = 1; 
   xform.XScalarNumerator = 1; 
   xform.YScalarDenominator = 1; 
   xform.YScalarNumerator = 1; 
 
   int x1 = image.ImageWidth / 4; 
   int y1 = image.ImageHeight / 4; 
   int x2 = image.ImageWidth / 3; 
   int y2 = image.ImageHeight / 3; 
 
   Point[] pts = 
   { 
      new Point(x1, y1), 
      new Point(x2, y1), 
      new Point(x1, y2), 
      new Point(x2, y2) 
   }; 
 
   image.AddPolygonToRegion(xform, pts, FillMode.Winding, RasterRegionCombineMode.Set); 
 
   // Draw something on the image 
   InvertCommand command = new InvertCommand(); 
   command.Run(image); 
 
   // Save the image 
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24); 
 
   image.Dispose(); 
   codecs.Dispose(); 
   RasterCodecs.Shutdown(); 
}

Remarks

To update an existing region, you specify how the new region is to be combined with the existing one using the combineMode parameter. For more information, refer to RasterRegionCombineMode.

For more information, refer to Creating a Region.

For more information, refer to Saving A Region.

For more information, refer to Working with the Existing Region.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also